<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JCSDK C# API Reference for Windows: JCSDK.JCClient.JCClient类 参考</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">JCSDK C# API Reference for Windows
   &#160;<span id="projectnumber">2.3.3.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'搜索');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','搜索');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_j_c_s_d_k.html">JCSDK</a></li><li class="navelem"><a class="el" href="namespace_j_c_s_d_k_1_1_j_c_client.html">JCClient</a></li><li class="navelem"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">类</a> &#124;
<a href="#pub-methods">Public 成员函数</a> &#124;
<a href="#pub-static-methods">静态 Public 成员函数</a> &#124;
<a href="#properties">属性</a> &#124;
<a href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client-members.html">所有成员列表</a>  </div>
  <div class="headertitle">
<div class="title">JCSDK.JCClient.JCClient类 参考<div class="ingroups"><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html">登录模块</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
类 JCSDK.JCClient.JCClient 继承关系图:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.png" usemap="#JCSDK.JCClient.JCClient_map" alt=""/>
  <map id="JCSDK.JCClient.JCClient_map" name="JCSDK.JCClient.JCClient_map">
<area href="interface_j_c_s_d_k_1_1_j_c_net_1_1_j_c_net_callback.html" alt="JCSDK.JCNet.JCNetCallback" shape="rect" coords="0,0,180,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
类</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public 成员函数</h2></td></tr>
<tr class="memitem:aa8973952c3eb5770ff01decf6e64a446"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> (string username, string password, string <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a5efee3e54dbdf2aaaa2088df7b9b7c14">serverAddress</a>, <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a> <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#af730e7b9ebc32dc63ed81b54cb672040">loginParam</a>)</td></tr>
<tr class="separator:aa8973952c3eb5770ff01decf6e64a446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b915efa9def2f560b41dec873ca8023"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a3b915efa9def2f560b41dec873ca8023">logout</a> ()</td></tr>
<tr class="separator:a3b915efa9def2f560b41dec873ca8023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c1ebb8327b5795e3c47e956d98a4399"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a7c1ebb8327b5795e3c47e956d98a4399">isSelf</a> (string <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a1e924fb8225bd48e81a5fe6b999c163c">userId</a>)</td></tr>
<tr class="separator:a7c1ebb8327b5795e3c47e956d98a4399"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
静态 Public 成员函数</h2></td></tr>
<tr class="memitem:acc9ff155cfdb0579add9b87f9d951b58"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> (Application <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a74072a6a0fd330378284dd46e16b868e">app</a>, string appKey, <a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html">JCClientCallback</a> callback, <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a> <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a3a725b0b0de9f7fc043c72b1810432ef">createParam</a>)</td></tr>
<tr class="separator:acc9ff155cfdb0579add9b87f9d951b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89cf88dca81e5cc7a95218f1d2003cbc"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a89cf88dca81e5cc7a95218f1d2003cbc">destroy</a> ()</td></tr>
<tr class="separator:a89cf88dca81e5cc7a95218f1d2003cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
属性</h2></td></tr>
<tr class="memitem:a3a725b0b0de9f7fc043c72b1810432ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a3a725b0b0de9f7fc043c72b1810432ef">createParam</a><code> [get]</code></td></tr>
<tr class="separator:a3a725b0b0de9f7fc043c72b1810432ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af730e7b9ebc32dc63ed81b54cb672040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#af730e7b9ebc32dc63ed81b54cb672040">loginParam</a><code> [get]</code></td></tr>
<tr class="separator:af730e7b9ebc32dc63ed81b54cb672040"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a242ae22a34c4ed31311a0a0aa9da8218"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a242ae22a34c4ed31311a0a0aa9da8218">displayName</a><code> [get, set]</code></td></tr>
<tr class="separator:a242ae22a34c4ed31311a0a0aa9da8218"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e924fb8225bd48e81a5fe6b999c163c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a1e924fb8225bd48e81a5fe6b999c163c">userId</a><code> [get]</code></td></tr>
<tr class="separator:a1e924fb8225bd48e81a5fe6b999c163c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5efee3e54dbdf2aaaa2088df7b9b7c14"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a5efee3e54dbdf2aaaa2088df7b9b7c14">serverAddress</a><code> [get]</code></td></tr>
<tr class="separator:a5efee3e54dbdf2aaaa2088df7b9b7c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b114554ece8a6e4e03dd8f91812b802"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">JCClientState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a8b114554ece8a6e4e03dd8f91812b802">state</a><code> [get]</code></td></tr>
<tr class="separator:a8b114554ece8a6e4e03dd8f91812b802"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74072a6a0fd330378284dd46e16b868e"><td class="memItemLeft" align="right" valign="top">Application&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a74072a6a0fd330378284dd46e16b868e">app</a><code> [get]</code></td></tr>
<tr class="separator:a74072a6a0fd330378284dd46e16b868e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac81aa6d461226adb64a8218e051b9ec1"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#ac81aa6d461226adb64a8218e051b9ec1">appkey</a><code> [get, set]</code></td></tr>
<tr class="separator:ac81aa6d461226adb64a8218e051b9ec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
<div class="textblock"><p>全局基础类</p>
<p>主要负责登录登出管理及账户属性存储 </p>
</div><h2 class="groupheader">成员函数说明</h2>
<a id="acc9ff155cfdb0579add9b87f9d951b58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc9ff155cfdb0579add9b87f9d951b58">&#9670;&nbsp;</a></span>create()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> JCSDK.JCClient.JCClient.create </td>
          <td>(</td>
          <td class="paramtype">Application&#160;</td>
          <td class="paramname"><em>app</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>appKey</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html">JCClientCallback</a>&#160;</td>
          <td class="paramname"><em>callback</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a>&#160;</td>
          <td class="paramname"><em>createParam</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>创建 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象</p>
<p><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 的所有接口函数，如无特殊说明，都建议在主线程调用</p>
<dl class="section note"><dt>注解</dt><dd><ul>
<li>请确保在调用其他 API 前先调用该方法创建并初始化 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象</li>
<li>调用此方法创建 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象后，期间没有调用过 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#a89cf88dca81e5cc7a95218f1d2003cbc">destroy</a> 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象</li>
</ul>
</dd></dl>
<dl class="params"><dt>参数</dt><dd>
  <table class="params">
    <tr><td class="paramname">appKey</td><td>用户从 Juphoon Cloud 平台上申请的 AppKey 字符串 </td></tr>
    <tr><td class="paramname">callback</td><td><a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html">JCClientCallback</a> 对象，用于回调相关通知 </td></tr>
    <tr><td class="paramname">createParam</td><td>创建参数，传入 null 则按默认值创建，详见 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>返回</dt><dd><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象 </dd></dl>
<dl class="exception"><dt>异常</dt><dd>
  <table class="exception">
    <tr><td class="paramname">appKey、callback 任意一个参数传空就会返回 null</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a89cf88dca81e5cc7a95218f1d2003cbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89cf88dca81e5cc7a95218f1d2003cbc">&#9670;&nbsp;</a></span>destroy()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void JCSDK.JCClient.JCClient.destroy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>销毁 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象</p>
<dl class="section note"><dt>注解</dt><dd>此方法为异步调用，所以在调用此方法后不能马上调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 方法去重新创建 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html">JCClient</a> 对象 </dd></dl>

</div>
</div>
<a id="a7c1ebb8327b5795e3c47e956d98a4399"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c1ebb8327b5795e3c47e956d98a4399">&#9670;&nbsp;</a></span>isSelf()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool JCSDK.JCClient.JCClient.isSelf </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>userId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>根据用户标识判断是否为自己 </p><dl class="params"><dt>参数</dt><dd>
  <table class="params">
    <tr><td class="paramname">userId</td><td>用户标识 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>是否为自己 </dd></dl>

</div>
</div>
<a id="aa8973952c3eb5770ff01decf6e64a446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8973952c3eb5770ff01decf6e64a446">&#9670;&nbsp;</a></span>login()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool JCSDK.JCClient.JCClient.login </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>username</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>password</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>serverAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a>&#160;</td>
          <td class="paramname"><em>loginParam</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>登录 Juphoon Cloud 平台</p>
<p>只有登录成功后才能进行平台上的各种业务</p>
<dl class="params"><dt>参数</dt><dd>
  <table class="params">
    <tr><td class="paramname">userId</td><td>用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）：<ul>
<li>26 个小写英文字母 a-z</li>
<li>26 个大写英文字母 A-Z</li>
<li>10 个数字 0-9</li>
<li>'+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位 </li>
</ul>
</td></tr>
    <tr><td class="paramname">password</td><td>密码，不能为 nil 或 ""，长度不能超过 128 字符 </td></tr>
    <tr><td class="paramname">serverAddress</td><td>登录服务器地址，默认地址为 <a href="http:cn.router.justalkcloud.com:8080">http:cn.router.justalkcloud.com:8080</a>（国内环境）。如果是海外用户需要设置为 <a href="http:intl.router.justalkcloud.com:8080">http:intl.router.justalkcloud.com:8080</a>（国际环境） </td></tr>
    <tr><td class="paramname">loginParam</td><td>登录参数，一般不需要设置，如需设置请询问客服，传 null 则按默认值，详见 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>调用是否成功<ul>
<li>true：正常执行调用流程，登录结果通过 <a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html#a1fcb2cca41cc7030e32de7df7c2c35c5">onLogin</a> 通知</li>
<li>false：调用异常，不会收到 <a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html#a1fcb2cca41cc7030e32de7df7c2c35c5">onLogin</a> 通知 </li>
</ul>
</dd></dl>

</div>
</div>
<a id="a3b915efa9def2f560b41dec873ca8023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b915efa9def2f560b41dec873ca8023">&#9670;&nbsp;</a></span>logout()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool JCSDK.JCClient.JCClient.logout </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>登出 Juphoon Cloud 平台</p>
<p>登出后不能进行平台上的各种业务</p>
<dl class="section return"><dt>返回</dt><dd>调用是否成功<ul>
<li>true：正常执行调用流程，登出结果通过 <a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html#a024c5388fdd7fef805d780739a69a16d">onLogout</a> 通知</li>
<li>false：调用失败，不会收到 <a class="el" href="interface_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_callback.html#a024c5388fdd7fef805d780739a69a16d">onLogout</a> 通知 </li>
</ul>
</dd></dl>

</div>
</div>
<h2 class="groupheader">属性说明</h2>
<a id="a74072a6a0fd330378284dd46e16b868e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74072a6a0fd330378284dd46e16b868e">&#9670;&nbsp;</a></span>app</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Application JCSDK.JCClient.JCClient.app</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取 Application 实例</p>
<p>得到的 Application 对象是调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 方法时传入 </p>

</div>
</div>
<a id="ac81aa6d461226adb64a8218e051b9ec1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac81aa6d461226adb64a8218e051b9ec1">&#9670;&nbsp;</a></span>appkey</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string JCSDK.JCClient.JCClient.appkey</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取 appkey</p>
<p>得到的 appkey 是调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 方法时传入的 </p>

</div>
</div>
<a id="a3a725b0b0de9f7fc043c72b1810432ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a725b0b0de9f7fc043c72b1810432ef">&#9670;&nbsp;</a></span>createParam</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a> JCSDK.JCClient.JCClient.createParam</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取创建参数</p>
<p>得到的创建参数就是用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 方法时传入的 createParam 参数 </p>
<p>若用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 方法时，createParam 传入了 null，则返回默认的 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_create_param.html">CreateParam</a> 对象 </p>

</div>
</div>
<a id="a242ae22a34c4ed31311a0a0aa9da8218"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a242ae22a34c4ed31311a0a0aa9da8218">&#9670;&nbsp;</a></span>displayName</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string JCSDK.JCClient.JCClient.displayName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取/设置自己的昵称</p>
<p>以下情况时，都会将自己的昵称发送给其他用户：</p><ul>
<li>调用 <a class="el" href="">call</a> 发起呼叫时</li>
<li>调用 <a class="el" href="">join</a> 加入频道时</li>
<li>调用 <a class="el" href="">sendMessage</a>、<a class="el" href="">sendFile</a> 发送消息时</li>
</ul>
<p>各模块获取对方昵称的方法：</p><ul>
<li>通话场景获取对方昵称：displayName</li>
<li>消息场景获取对方昵称：dsplayName</li>
<li>会议频道场景获取对方昵称：displayName</li>
</ul>
<dl class="section note"><dt>注解</dt><dd>每次调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#acc9ff155cfdb0579add9b87f9d951b58">create</a> 初始化 SDK 后都需要重新设置 </dd></dl>

</div>
</div>
<a id="af730e7b9ebc32dc63ed81b54cb672040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af730e7b9ebc32dc63ed81b54cb672040">&#9670;&nbsp;</a></span>loginParam</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a> JCSDK.JCClient.JCClient.loginParam</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取登录参数</p>
<p>得到的登录参数就是用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> 方法时传入的 loginParam 参数 <br  />
 若用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> 方法时， loginParam 传入了 null，则将返回默认的 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client_1_1_login_param.html">LoginParam</a> 对象 <br  />
 需要注意的是只有用户状态为登录中或已登录时才能获取到值，其他状态将返回 null </p>

</div>
</div>
<a id="a5efee3e54dbdf2aaaa2088df7b9b7c14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5efee3e54dbdf2aaaa2088df7b9b7c14">&#9670;&nbsp;</a></span>serverAddress</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string JCSDK.JCClient.JCClient.serverAddress</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取登录服务器地址</p>
<p>得到的登录地址就是用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> 方法时传入的 serverAddress 参数 <br  />
 若用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> 方法时，serverAddress 传入了 null 或者 ""，将返回默认地址 <a href="http:cn.router.justalkcloud.com:8080">http:cn.router.justalkcloud.com:8080</a> <br  />
 需要注意的是只有用户状态为登录中或已登录才能获取到值，其他状态将返回 null </p>

</div>
</div>
<a id="a8b114554ece8a6e4e03dd8f91812b802"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b114554ece8a6e4e03dd8f91812b802">&#9670;&nbsp;</a></span>state</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">JCClientState</a> JCSDK.JCClient.JCClient.state</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取当前登录状态</p>
<ul>
<li><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">NotInit</a> : 未初始化</li>
<li><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">Idle</a> : 未登录</li>
<li><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">Logining</a> : 登录中</li>
<li><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">Logined</a> : 登录成功</li>
<li><a class="el" href="group___xE7_x99_xBB_xE5_xBD_x95_xE6_xA8_xA1_xE5_x9D_x97.html#ga2aa0686490aced8d8c24d3318a989af8">Logouting</a> : 登出中 </li>
</ul>

</div>
</div>
<a id="a1e924fb8225bd48e81a5fe6b999c163c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e924fb8225bd48e81a5fe6b999c163c">&#9670;&nbsp;</a></span>userId</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string JCSDK.JCClient.JCClient.userId</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>获取用户标识</p>
<p>得到的的用户标识就是用户在调用 <a class="el" href="class_j_c_s_d_k_1_1_j_c_client_1_1_j_c_client.html#aa8973952c3eb5770ff01decf6e64a446">login</a> 方法时传入的 userId 参数 <br  />
 需要注意的是只有用户状态为登录中或已登录才能获取到值，其他状态将返回 null </p>

</div>
</div>
<hr/>该类的文档由以下文件生成:<ul>
<li>JCSDK/JCSDK/JCClient/JCClient.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
